<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>WorkspaceView</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='WorkspaceView.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        WorkspaceView
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;workspace-view.coffee</td>
        </tr>
        <tr>
          <td>Inherits:</td>
          <td>
            <a href='View.html'>View</a>
          </td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>The container for the entire Atom application.</p><p>An instance of this class is always available as the <code>atom.workspaceView</code>
global.</p><h2 id="commands">Commands</h2>
<ul>
<li><code>application:about</code> - Opens the about dialog.</li>
<li><code>application:show-settings</code> - Opens the preference pane in the currently
focused editor.</li>
<li><code>application:quit</code> - Quits the entire application.</li>
<li><code>application:hide</code> - Hides the entire application.</li>
<li><code>application:hide-other-applications</code> - Hides other applications
running on the system.</li>
<li><code>application:unhide-other-applications</code> - Shows other applications
that were previously hidden.</li>
<li><code>application:new-window</code> - Opens a new <a href='https://atom.io/docs/api/v0.61.0/api/classes/AtomWindow.html'>AtomWindow</a> with no <a href='Project.html'>Project</a>
path.</li>
<li><code>application:new-file</code> - Creates a new file within the focused window.
Note: only one new file may exist within an <a href='https://atom.io/docs/api/v0.61.0/api/classes/AtomWindow.html'>AtomWindow</a> at a time.</li>
<li><code>application:open</code> - Prompts the user for a path to open in a new <a href='https://atom.io/docs/api/v0.61.0/api/classes/AtomWindow.html'>AtomWindow</a></li>
<li><code>application:minimize</code> - Minimizes the currently focused <a href='https://atom.io/docs/api/v0.61.0/api/classes/AtomWindow.html'>AtomWindow</a></li>
<li><code>application:zoom</code> - Expands the window to fill the screen or returns it to
it&#39;s original unzoomed size.</li>
<li><code>application:bring-all-windows-to-front</code> - Brings all <a href='https://atom.io/docs/api/v0.61.0/api/classes/AtomWindow.html'>AtomWindow</a>s to the
the front.</li>
</ul>
<h2 id="requiring-in-package-specs">Requiring in package specs</h2>
<pre><code class="lang-coffee">  {WorkspaceView} = require &#39;atom&#39;
</code></pre>

</div>
<div class='tags'>
</div>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#appendToBottom-instance'>
        ::<strong>appendToBottom</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Appends the element to bottom of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#appendToLeft-instance'>
        ::<strong>appendToLeft</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Appends the element to the left side of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#appendToRight-instance'>
        ::<strong>appendToRight</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Appends the element to the right side of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#appendToTop-instance'>
        ::<strong>appendToTop</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Appends the element to the top of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#confirmClose-instance'>
        ::<strong>confirmClose</strong>()
      </a>
    </span>
    <span class='desc'>
      Shows a dialog asking if the pane was <em>really</em> meant to be closed.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#eachEditorView-instance'>
        ::<strong>eachEditorView</strong>(callback)
      </a>
    </span>
    <span class='desc'>
      Fires a callback on each open <a href='EditorView.html'>EditorView</a>.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#eachPaneView-instance'>
        ::<strong>eachPaneView</strong>(callback)
      </a>
    </span>
    <span class='desc'>
      Fires a callback on each open <a href='PaneView.html'>PaneView</a>.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusNextPaneView-instance'>
        ::<strong>focusNextPaneView</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the next pane by id.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusPaneViewAbove-instance'>
        ::<strong>focusPaneViewAbove</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the pane directly above the active pane.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusPaneViewBelow-instance'>
        ::<strong>focusPaneViewBelow</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the pane directly below the active pane.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusPaneViewOnLeft-instance'>
        ::<strong>focusPaneViewOnLeft</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the pane directly to the left of the active pane.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusPaneViewOnRight-instance'>
        ::<strong>focusPaneViewOnRight</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the pane directly to the right of the active pane.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#focusPreviousPaneView-instance'>
        ::<strong>focusPreviousPaneView</strong>()
      </a>
    </span>
    <span class='desc'>
      Focuses the previous pane by id.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#getActivePaneItem-instance'>
        ::<strong>getActivePaneItem</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the currently focused item from within the focused <a href='PaneView.html'>PaneView</a>
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#getActivePaneView-instance'>
        ::<strong>getActivePaneView</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the currently focused <a href='PaneView.html'>PaneView</a>.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#getActiveView-instance'>
        ::<strong>getActiveView</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the view of the currently focused item.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#prependToBottom-instance'>
        ::<strong>prependToBottom</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Prepends the element to the bottom of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#prependToLeft-instance'>
        ::<strong>prependToLeft</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Prepends the element to the left side of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#prependToRight-instance'>
        ::<strong>prependToRight</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Prepends the element to the right side of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#prependToTop-instance'>
        ::<strong>prependToTop</strong>(element)
      </a>
    </span>
    <span class='desc'>
      Prepends the element to the top of the window.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#setTitle-instance'>
        ::<strong>setTitle</strong>(title)
      </a>
    </span>
    <span class='desc'>
      Sets the application&#39;s title.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='WorkspaceView.html#updateTitle-instance'>
        ::<strong>updateTitle</strong>()
      </a>
    </span>
    <span class='desc'>
      Updates the application&#39;s title, based on whichever file is open.
    </span>
  </li>
</ul>
      <h2>
        <small>Inherited Method Summary</small>
      </h2>
      <h3 class='inherited'>
        Methods inherited from
        <a href='View.html'>View</a>
      </h3>
      <p class='inherited'>
                <a href='View.html#subview-class'>@subview</a>,
                <a href='View.html#text-class'>@text</a>,
                <a href='View.html#tag-class'>@tag</a>,
        <a href='View.html#raw-class'>@raw</a>
      </p>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='appendToBottom-instance'>
      ::<strong>appendToBottom</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Appends the element to bottom of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='appendToLeft-instance'>
      ::<strong>appendToLeft</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Appends the element to the left side of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='appendToRight-instance'>
      ::<strong>appendToRight</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Appends the element to the right side of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='appendToTop-instance'>
      ::<strong>appendToTop</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Appends the element to the top of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='confirmClose-instance'>
      ::<strong>confirmClose</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Shows a dialog asking if the pane was <em>really</em> meant to be closed.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='eachEditorView-instance'>
      ::<strong>eachEditorView</strong>(callback)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Fires a callback on each open <a href='EditorView.html'>EditorView</a>.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='eachPaneView-instance'>
      ::<strong>eachPaneView</strong>(callback)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Fires a callback on each open <a href='PaneView.html'>PaneView</a>.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusNextPaneView-instance'>
      ::<strong>focusNextPaneView</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the next pane by id.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusPaneViewAbove-instance'>
      ::<strong>focusPaneViewAbove</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the pane directly above the active pane.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusPaneViewBelow-instance'>
      ::<strong>focusPaneViewBelow</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the pane directly below the active pane.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusPaneViewOnLeft-instance'>
      ::<strong>focusPaneViewOnLeft</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the pane directly to the left of the active pane.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusPaneViewOnRight-instance'>
      ::<strong>focusPaneViewOnRight</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the pane directly to the right of the active pane.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='focusPreviousPaneView-instance'>
      ::<strong>focusPreviousPaneView</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Focuses the previous pane by id.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getActivePaneItem-instance'>
      ::<strong>getActivePaneItem</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the currently focused item from within the focused <a href='PaneView.html'>PaneView</a></p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getActivePaneView-instance'>
      ::<strong>getActivePaneView</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the currently focused <a href='PaneView.html'>PaneView</a>.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getActiveView-instance'>
      ::<strong>getActiveView</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the view of the currently focused item.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='prependToBottom-instance'>
      ::<strong>prependToBottom</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Prepends the element to the bottom of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='prependToLeft-instance'>
      ::<strong>prependToLeft</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Prepends the element to the left side of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='prependToRight-instance'>
      ::<strong>prependToRight</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Prepends the element to the right side of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='prependToTop-instance'>
      ::<strong>prependToTop</strong>(element)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Prepends the element to the top of the window.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setTitle-instance'>
      ::<strong>setTitle</strong>(title)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Sets the application&#39;s title.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='updateTitle-instance'>
      ::<strong>updateTitle</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Updates the application&#39;s title, based on whichever file is open.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Thu Feb 27 2014 16:02:52 GMT-0800 (PST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.0
  (Node.js v0.10.21).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>